<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>BoardGame 3000: MiniBreak Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">BoardGame 3000
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">A simple board game structure</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">MiniBreak Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for MiniBreak:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_mini_break.png" usemap="#MiniBreak_map" alt=""/>
  <map id="MiniBreak_map" name="MiniBreak_map">
<area href="class_i_game.html" title="Base class for games." alt="IGame" shape="rect" coords="0,0,69,24"/>
</map>
 </div></div>

<p><a href="class_mini_break-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acc5bca00d7ce22a5cbb02c128c5e1748"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#acc5bca00d7ce22a5cbb02c128c5e1748">start</a> ()</td></tr>
<tr class="memitem:acce22a4f8cad9186ee4d6ec69e38844e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#acce22a4f8cad9186ee4d6ec69e38844e">legal</a> ()</td></tr>
<tr class="memitem:a77b40960799b41ade7d6083743b2de7d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#a77b40960799b41ade7d6083743b2de7d">make</a> (int fromX, int fromY, int toX, int toY)</td></tr>
<tr class="memitem:ab5b3f268cbed4737042e3a7cc9d7535d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#ab5b3f268cbed4737042e3a7cc9d7535d">retract</a> ()</td></tr>
<tr class="memitem:af30cb36726fedb3fd340eff5760396b4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#af30cb36726fedb3fd340eff5760396b4">display</a> ()</td></tr>
<tr class="memitem:a6a6756085f55039602a794bbc3631616"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#a6a6756085f55039602a794bbc3631616">evaluate</a> ()</td></tr>
<tr class="memitem:aa731242edd9d83e884a605b487af2438"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#aa731242edd9d83e884a605b487af2438">go</a> ()</td></tr>
<tr class="memitem:ad19c8e7cffa735e354f13acaaeed0694"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad19c8e7cffa735e354f13acaaeed0694"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>level</b> ()</td></tr>
<tr class="memitem:a2a25ca0244191d9db053f4d77503a881"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#a2a25ca0244191d9db053f4d77503a881">debug</a> ()</td></tr>
<tr class="memitem:a5390cdf368f5c9e73cd2cc19b68b1f6f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_break.html#a5390cdf368f5c9e73cd2cc19b68b1f6f">getName</a> ()</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2a25ca0244191d9db053f4d77503a881"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#a2a25ca0244191d9db053f4d77503a881">MiniBreak::debug</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Toggles debug mode on/off if debug is on, software should display additional information as it runs, otherwise only if asked for </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#a708979bb871a85d348691ee4a0136ccf">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="af30cb36726fedb3fd340eff5760396b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#af30cb36726fedb3fd340eff5760396b4">MiniBreak::display</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Prints out current gameState </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#af84c5ff1b9d776381994b349601b1c24">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="a6a6756085f55039602a794bbc3631616"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#a6a6756085f55039602a794bbc3631616">MiniBreak::evaluate</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Displays the evaluation of current gamestate </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#a0931c237dcb52b18d117abcb47363d5f">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="a5390cdf368f5c9e73cd2cc19b68b1f6f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="class_mini_break.html#a5390cdf368f5c9e73cd2cc19b68b1f6f">MiniBreak::getName</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns string, with name of game </p>

<p>Implements <a class="el" href="class_i_game.html#a43bfc6eee8384673e768016b7082c264">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="aa731242edd9d83e884a605b487af2438"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#aa731242edd9d83e884a605b487af2438">MiniBreak::go</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The computer plays the next move Displays the move it makes if no more moves are available, it displays final score </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#ac201277e2d76453b5eb33938eb5ed6a3">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="acce22a4f8cad9186ee4d6ec69e38844e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#acce22a4f8cad9186ee4d6ec69e38844e">MiniBreak::legal</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Prints out all legal moves </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#a7dde4d727104e457208fc0f492cb5958">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="a77b40960799b41ade7d6083743b2de7d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#a77b40960799b41ade7d6083743b2de7d">MiniBreak::make</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>fromX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>fromY</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>toX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>toY</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Moves <a class="el" href="class_piece.html" title="One Piece on the board.">Piece</a>, Only calls movePiece() function in state </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#a90e8f12cc54b0f8907c29078a82efc58">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="ab5b3f268cbed4737042e3a7cc9d7535d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#ab5b3f268cbed4737042e3a7cc9d7535d">MiniBreak::retract</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retract last move, Only calls <a class="el" href="class_mini_break.html#ab5b3f268cbed4737042e3a7cc9d7535d">retract()</a> function in state </p>

<p>Reimplemented from <a class="el" href="class_i_game.html#a60314a983073a4014639b403229b6c83">IGame</a>.</p>

</div>
</div>
<a class="anchor" id="acc5bca00d7ce22a5cbb02c128c5e1748"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_mini_break.html#acc5bca00d7ce22a5cbb02c128c5e1748">MiniBreak::start</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Starts the game, Function supposed to initilize board and start <a class="el" href="class_game_state.html" title="Class that holds information and methods for current game.">GameState</a> </p>

<p>Implements <a class="el" href="class_i_game.html#abdc3543ee754cecb7eb156f05ce5869d">IGame</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_mini_break_8h_source.html">MiniBreak.h</a></li>
<li>MiniBreak.cpp</li>
</ul>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Sat May 12 2012 15:22:53 for BoardGame 3000 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>
